Skip to main content

PPMT

Returns the payment on the principal for a given investment based on periodic, constant payments and a constant interest rate.

Syntax

expression.PPMT(arg1, arg2, arg3, arg4, arg5, arg6);

expression - A variable that represents a ApiWorksheetFunction class.

Parameters

NameRequired/OptionalData typeDefaultDescription
arg1RequiredApiRangeApiNamenumber
arg2RequiredApiRangeApiNamenumber
arg3RequiredApiRangeApiNamenumber
arg4RequiredApiRangeApiNamenumber
arg5RequiredApiRangeApiNamenumber
arg6RequiredApiRangeApiNamenumber

Returns

number

Example

var oWorksheet = Api.GetActiveSheet();
var oFunction = Api.GetWorksheetFunction();
oWorksheet.GetRange("A1").SetValue(oFunction.PPMT(0.1/12, 1, 2*12, 2000, 0));